home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / macorg32.zip / ORIGIN.DOC < prev    next >
Text File  |  1993-01-20  |  17KB  |  425 lines
  1.  
  2.  
  3.                       ╔═══════════════════════════╗
  4.                       ║ A MÄC's Place BBS Release ║
  5.                       ╚═══════════════════════════╝
  6.  
  7.  
  8.  
  9.              FILE ORIGINS: File Download / Upload Searches
  10.              ~~~~ ~~~~~~~  ~~~~ ~~~~~~~~ ~ ~~~~~~ ~~~~~~~~
  11.  
  12.                             Version  3.2
  13.  
  14.  
  15.               Copyright (c) 1989-1993 John W. McNamara
  16.                           All rights Reserved
  17.  
  18.  
  19.                               Written By:        
  20.  
  21.                              John McNamara      
  22.                         
  23.                             MÄC's Place BBS    
  24.                                Dunn, NC           
  25.  
  26.                         (919) 891-1111 [16.8 DS] 
  27.         
  28.                         Release Date: 20 Jan 1993
  29.  
  30.     ORIGINS - Version 3.2                                           Page - 1
  31.  
  32.  
  33.     File Origins - A MÄC's Place BBS Release PCBoard File Search Door
  34.  
  35.  
  36. ┌────────────────────────────────┐
  37. │ Files included in this Zip:    │
  38. └────────────────────────────────┘
  39.  
  40.     ORIGIN.EXE       - Main File Origins Executable File, Version 3.2
  41.     ORIGIN.CNF       - File Origins Sample Configuration File
  42.     ORIGIN           - File Origins Sample PCBoard Door File
  43.     ORIGIN.DOC       - Information on File Origins Door
  44.     ORIGIN.HIS       - Programme Release History
  45.     README.NOW       - Information on Files Available with the
  46.                        File Origins PCBoard Door
  47.     HOT_ADS.TXT      - Information on File Origins support programmes:
  48.             Hot Companion and BudMan.
  49.     BUDMAN30.ZIP     - Download.txt File splitter for PCBoard
  50.     HCOMP40.ZIP      - Download.txt Parser for PCBoard
  51.                ┌───────────────────────────────────────────────────┐
  52.                │ F I L E   O R I G I N S  -  V e r s i o n  3 . 1  │
  53.                └───────────────────────────────────────────────────┘
  54.                           ╔═════════════════════════════╗
  55.                           ║  A MÄC's Place BBS Release  ║
  56.                           ╚═════════════════════════════╝
  57.  
  58.    The File Origins door has two support programmes that are also available
  59.  
  60.  
  61.    HotStuff Companion [Version 4.0]
  62.    ==================
  63.         The HotStuff Companion programme was written because of the need to 
  64.         strip the DOWNLOAD.TXT and CALLER files created  by PCBoard (tm) of 
  65.         old, outdated, or unwanted files. When HotStuff or File Origins are
  66.         run, they may reflect files that are  no longer  on  your  Bulletin 
  67.         Board System.
  68.  
  69.         The programme uses a parsing  routine  [similar  to  the UNIX Grep]
  70.         to search a file line by line for a string and eliminate that  text
  71.         from the file.  The programme is available as: HCOMP40.ZIP.  It  is
  72.         included in this archive. It will now process 3 different strings at
  73.         once.
  74.  
  75.  
  76.    BudMan Utility [Version 3.0]
  77.    ==============
  78.         The BudMan programme does what PCBoard (tm) should already do.  It 
  79.         splits the DOWNLOAD.TXT file into two files, one with the downloads 
  80.         and  the  other  with  uploads.   The  programme  is  available as: 
  81.         BUDMAN30.ZIP.  It is inlcuded with the archive.
  82.  
  83.  
  84.     ORIGINS - Version 3.2                                           Page - 2
  85. ╔══════════════╗
  86. ║ Introduction ║
  87. ╚══════════════╝
  88.  
  89.   Welcome to File  Origins !! File  Origins is a  PCBoard door programme  that
  90.   allows the user to  perform an extremely RAPID  search of file downloads  or
  91.   uploads  on   a BBS  for  a specific key search  string.  The programme  can
  92.   locate  any  key  string  that  is  contained within file download or upload
  93.   files.  The  search string can  be a user  name, file name,  or even a date.
  94.   Some examples would include:
  95.  
  96.        HOTDOG            - any accesses to this file
  97.        MCNAMARA          - any activity by this user
  98.        05-10-1993        - any activity on this date
  99.  
  100.  
  101.  
  102.   It is recommended  that you use  separate download and  upload file listings
  103.   for the programme.   We have included  the BudMan programme  which automates
  104.   the separation  of   the  standard  PCBoard   Download.txt  file  into   two
  105.   files:  a download and upload  file [something that PCBoard should be  doing
  106.   anyway !!].  The  File Origins programme reads  from two files for  the file
  107.   downloads  and uploads.  Of course you could  read from the same  file [eg -
  108.   Download.txt] for both downloads and uploads.
  109.  
  110.   One of the main  features of the File  Origins programme is its  SPEED !! It
  111.   is  written  in  Borland C++ 3.2    with an Assembler string parsing routine
  112.   [similar to the UNIX Grep] to maximize the search speed. It is approximately
  113.   33 percent faster than  Sam Smith's ProWho.   It has the added  feature that
  114.   it only  searches through  either an  Upload file  listing or  Download file
  115.   listing for the search string, which is not counted in the time trial.  
  116.  
  117.  
  118.     ORIGINS Version 3.2                                             Page - 2
  119.  
  120.   The main features of the File Origins programme include:
  121.  
  122.           o  It uses either an Upload file listing or Download file listing 
  123.                to locate the search string. 
  124.           o  It can also only use one file if you don't want to split it
  125.           o  Extreamly fast
  126.       o  Share and Network Compatible allowing it to be run on multiple 
  127.                nodes.
  128.           o  Full comm support up to 115,000 baud
  129.           o  Provides ALL PCBoard Funtion keys and features
  130.  
  131.  
  132.  
  133.     ORIGINS - Version 3.2                                           Page - 3
  134. ╔═══════════════════════════════╗
  135. ║ File Origins Door Operation:  ║
  136. ╚═══════════════════════════════╝
  137.  
  138.   The operation of the File Origins Door is straight forward. The programme  
  139.   presents the welcome screen and then displays the main menu. 
  140.  
  141.                        File ORIGIN/DESTINATION Door
  142. For a 2 file system:
  143.  
  144. [U] Search for files that have been Uploaded
  145. [D] Search for files that have been Downloaded
  146. [H] Help
  147. [Q] Quit to BBS
  148. [G] Log off BBS
  149.  
  150. The user then has two main choices: Upload Search or Download Search.
  151.  
  152. For a 1 file system:
  153.  
  154. [D] Search for files that have been Downloaded/Uploaded
  155. [H] Help
  156. [Q] Quit to BBS
  157. [G] Log off BBS
  158.  
  159. The user then has One main choice: Upload Search and Download Search.
  160.  
  161. ┌───────────────┐
  162. │ UPLOAD SEARCH │
  163. └───────────────┘
  164.   The user can search for any key string that is located within the Upload 
  165.   File listing.  
  166.  
  167.  
  168.     ORIGINS Version 3.2                                             Page - 3
  169.  
  170. ┌─────────────────┐
  171. │ DOWNLOAD SEARCH │
  172. └─────────────────┘
  173.  
  174.   The user  can also  search for  any key  string that  is located  within the
  175.   Download File listing.  
  176.  
  177. ┌──────┐
  178. │ QUIT │
  179. └──────┘
  180.   Finally, the user can return to PCBoard after they have finished using the 
  181.   File Origins Door. 
  182.  
  183. ┌─────────┐
  184. │ GOODBYE │
  185. └─────────┘
  186.   Finally, the user can exit the BBS from the DOOR.
  187.  
  188.     ORIGINS Version 3.2                                             Page - 4
  189. ╔══════════════╗
  190. ║ INSTALLATION ║
  191. ╚══════════════╝
  192.  
  193. 1. Configure PCBoard for Origin door:
  194.      Using PCBoard's PCBsetup program, add the door to your list of doors.
  195.      Fields:
  196.         Filename        -        SYSOPs Choice   (must match startup file)
  197.         Password        -        SYSOPs Choice
  198.         Sec             -        SYSOPs Choice
  199.         Login           -        SYSOPs Choice (Not recommended)
  200.         User Sys        -        Yes
  201.         Door Sys        -        No
  202.         Shell           -        No
  203.         Path to Files   -        Not Needed
  204.  
  205. 2.  Make directory for Origin door
  206.      - Make a directory to hold the Origin door files.
  207.      - i.e.  mkdir \doors\Origin
  208.  
  209. 3.  Create the start up file i.e. ORIGIN
  210.      - a sample is listed below
  211.  
  212.       @echo off
  213.       c:
  214.       cd \doors\origin
  215.       origin origin.cnf
  216.       cd \pcb
  217.       board
  218.  
  219. 4.  Copy files to appropriate places
  220.      - copy Origin door.exe and Origin door.cfg to the Origin door directory.
  221.      - copy the startup file into the default PCBoard directory i.e. \pcb
  222.        or place it in your dos path
  223.  
  224. 5.  Create the configuration file  i.e. ORIGIN.CNF
  225.    If the first line is a "1" then the board will process the file in the
  226.    next line only.  If the first line is a "2" then it will process both
  227.    following lines.  A "2" is the perfered method as this will increase
  228.    the speed in which the search is done, because its only looking through
  229.    uploads OR downloads and not both.  However a "1" is extreamly fast also.
  230.    
  231.    Example xxxxxxxx.CNF file:
  232.    2                          <== Number of files to support 1 or 2
  233.    F:\pcb\main\DOWNLOAD.TXT   <== Location of Download File Listings 
  234.    F:\pcb\main\UPLOAD.TXT     <== Location of UpLoad File Listings 
  235.  
  236.   The following sysop functions are available while awaiting keyboard input :
  237.  
  238.   One of   the  nicer   features about   using the TWIT  key,  is  the user is
  239.   not told that "the  sysop wants them  to return to  the BBS".   Instead,   a
  240.   Whatever you have set in your PCBTEXT file will show under the door.
  241.  
  242.   When using  the F5 shell to  DOS key, to return to the door  program, simply
  243.   type  EXIT  at  the  DOS  command  prompt.  It  is  not  necessary to change
  244.   directories  back  to  the  door  directory.  ORIGIN is smart enough to know
  245.   which drive  and directory  the door  program is   in and   will reset   the
  246.   defaults upon return  from DOS.   In addition, the  status line will  remain
  247.   "glued" to the screen.
  248.  
  249.   You have full PCBoard funtions keys.
  250.  
  251.     ORIGINS Version 3.2                                             Page - 5
  252.  
  253.  ╔═════════════════════════════╗
  254.  ║  A MÄC's Place BBS Release  ║
  255.  ╚═════════════════════════════╝
  256.  
  257. History of the File Origins Door Changes  [in reverse order]
  258. ═════════════════════════════════════════
  259.        ORIGIN 3.2:  20 January 1993
  260.          o Fixed the Sharing problem PCBoard has with network delays
  261.          o Added BBS name in opening screen
  262.          o Now 27% faster than previous version.
  263.          o Added more error messages, that write to callers log
  264.          o Now shows "How Many Matches" were found, see I listen !
  265.  
  266.        ORIGIN 3.1:  4 January 1993
  267.          o Added Support for single file operation
  268.          o Added Full screen help for users
  269.          o improved Speed by 4% 
  270.          o 115,000 baud rate now supported
  271.          o Now report number of lines processed
  272.          o Added ^S and ^K support (suspend and Kill)
  273.  
  274.        ORIGIN 3.0:  23 December  1992
  275.          o Re-wrote the entire package WITHOUT the GAPCDR library.
  276.            Completly different, a re-release !
  277.  
  278.        ORIGIN 2.2:  4 February  1990
  279.          o Re-Wrote Searching Function is MicroSoft Assembler, link
  280.            it in at compile time.  Increase in search speed.
  281.          o Took out the hardcoded command line: origin origin.cnf
  282.            now the "origin.cnf" can be anything you want i.e. 
  283.            origin1.cnf - origin2.cnf - origin3.cnf  etc....
  284.          o Added support for opening the door at 38,400 baud.  Up from
  285.            19,200 baud.
  286.          o Error messages are now displayed if a file isn't found.
  287.          o Added virtual buffer on both files that are read, its less
  288.            disk intensive and faster.
  289.          o Slowed down the closing of the door so the entire message is
  290.            displayed.
  291.          o Added version number to opening screen as per SYSOP request
  292.        
  293.        ORIGIN 2.1:  15 December 1989
  294.          o Fixed bug in the EXIT of the program, it used to turn 
  295.            the screen Blue after exiting the door, whether you
  296.            had graphics mode selected or not.  Basically, the
  297.            door closed too fast to allow a reset of colors
  298.  
  299.        ORIGIN 2.0:  13 December 1989
  300.          o Re-Wrote Searching fucntion.   Version 1.1 processed
  301.            15,000 lines in 56.0 secs and Version 2.0 processes
  302.            15,000 lines in 26.0 secs on a 10 mHz AT Clone.
  303.          o Changed the OutPut to the screen so its a little easier
  304.            to read.  Used Tokens to do this, did NOT use a structure
  305.            because users would rather have it fast instead of pretty
  306.          o Due to SYSOP request I took the (P)age SYSOP function out
  307.          o Changed Enviorment Variable MACDOOR=PCB
  308.  
  309.        ORIGIN 1.1:  10 October 1989
  310.  
  311.          o Changed Opening screen Phone number to reflect the
  312.            move of MÄC's Place.  SYSOPs Please replace .EXE file
  313.            with the new one.  Thankyou.
  314.  
  315.     ORIGINS Version 3.2                                             Page - 6           
  316.        ORIGIN 1.0:  18 May 1989
  317.  
  318.          o Initial Public Release of File Origins by NAPSWare Productions.
  319.          o Help Screens are in Full ANSI Color.
  320.          o Fully network compatible, can be run in a multi-node environment.
  321.          o Displays the number of sucessful matches found and the total 
  322.            number of lines read for each search.
  323.  
  324.        ORIGIN 0.8ß: 16 May 1989
  325.  
  326.          o Fixed problem with the scrolling of multiple screens of text
  327.            information.
  328.          o Improved ANSI color graphics Help screen output.
  329.  
  330.        ORIGIN 0.5ß: 11 May 1989
  331.  
  332.          o Initial Beta Release of File Origins by NAPSWare Productions.
  333.          o Supports PCBoard Version 14.x Only !! 
  334.          o Uses modified version of GAPCDR Support LIBrary for PCBoard
  335.            communications and system functions.
  336.          o Reads separate input files for upload / download text searches,
  337.            or optionally can read the same input file.           
  338.  
  339.  
  340.  These  files  are  distributed  under  the  FreeWare concept - freely 
  341.  available  to PCBoard  SysOps. Please  Do Not   distribute  modified  
  342.  versions without permission of the author.
  343.  
  344.  Do Not remove this notice or any other copyright notice.
  345.  
  346.                          ╔══════════════════╗
  347.                          ║══════════════════║
  348.                          ║    DISCLAIMER    ║
  349.                          ║══════════════════║
  350.                          ╚══════════════════╝
  351.  
  352.  
  353.    THIS PRODUCT IS LICENSED  "AS IS" WITHOUT ANY WARRANTY OF MERCHANTABILITY
  354.    OR FITNESS  FOR  A  PARTICULAR  PURPOSE,  PERFORMANCE,  OR OTHERWISE. ALL
  355.    WARRANTIES ARE EXPRESSLY DISCLAIMED.  BY  USING  THE  FILE  ORIGINS  DOOR 
  356.    PROGRAM    YOU AGREE THAT JOHN MCNAMARA WILL NOT BE  LIABLE TO YOU OR ANY 
  357.    THIRD PARTY FOR ANY USE OF (OR INABILITY TO USE)  OR  PERFORMANCE OF THIS 
  358.    PROGRAMME, OR FOR ANY DAMAGES WHATSOEVER WHETHER BASED ON CONTRACT,  TORT 
  359.    OR OTHERWISE. EVEN IF WE ARE NOTIFIED OF SUCH POSSIBILITY IN ADVANCE.
  360.  
  361.    You may not reverse-engineer, disassemble, modify,  decompile or  create
  362.    derivative works of this programme.  Piracy has been investigated by the
  363.    FBI and prosecuted under federal statutes.   Applicable law provides for
  364.    damages  and recovery of attorney's fees.   Distribution  of  any  MAC's 
  365.    Place BBS  Release program's  in  any  medium  without  its accompanying 
  366.    documentation is  an  unauthorized  modification.  That  is  a  theft of 
  367.    intellectual property.  
  368.  
  369.    ----------------
  370.      PCBoard  (C) is a registered trademark of Clark Development Company.
  371.  
  372.     ORIGINS Version 3.2                                             Page - 7
  373.                                  LICENSE
  374.                                  =======
  375.  The  File  Origins  PCBoard  Door  programme  can be  freely distributed  so
  376.  long  as  it  is  not  modified  or  sold  for  profit.  If you find that the
  377.  programme is  valuable, you  can send  a donation  for what  you think  it is
  378.  worth.  A donnation of $5 is suggested.
  379.  
  380.  Please Send your contributions to:
  381.  
  382.  
  383.     MAC's Place BBS
  384.     ATTN:John McNamara
  385.     P.O. Box 911
  386.     Dunn, NC 28335
  387.  
  388.  If you have any questions, bugs, or suggestions, please contact:
  389.  
  390.                                    
  391.      John McNamara - SysOp         
  392.      Mäc's Place BBS               
  393.      (919) 891-1111 16.8K Dual Std
  394.  
  395.    The latest version is always available for downloading.
  396.  
  397. ╔══════════════════════════╗
  398. ║ File Origins Background: ║
  399. ╚══════════════════════════╝
  400.   John McNamara wrote all the code for File Origins in approximately 4  hours.
  401.  
  402.   The File Origins door programme is written in C++ and Assembler routines and
  403.   was compiled with Borland C++ 3.2  The ORIGIN C LIBrary    The ORIGIN source
  404.   code LIBrary  was modified  and recompiled  with our  specific improvements.
  405.   The C++ language  was choosen for  writing several of  the  MÄC's Place BBS  
  406.   PCBoard utilities   such as   File Origins Door  because  of  its  speed and
  407.   flexibility.  The C++  source is available upon request and for small fee.  
  408.  
  409.   Want to thank the following BETA sites:
  410.     The Poor Boys BBS     (216) 726-3589
  411.     Sysop - Rin Herring
  412.  
  413.     Channel One BBS       (617) 354-8873
  414.     Sysops - Brian Miller/Tess Heder
  415.  
  416.     FreeWare Hall of Fame  (804) 293-4710
  417.     Sysop - Rey Barry
  418.      
  419.  
  420.      Author:
  421.                                      
  422.      John McNamara - SysOp           
  423.      MÄC's Place BBS                 
  424.      (919) 891-1111 [16.8 DS]      
  425.